﻿Ted - Text Dumper Utility
Copyright (C) 2009  Rocket Science

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

--Table of Contents--
1. Revision History
	- v1.0
2. Introduction
3. Installation
4. Usage
5. FAQs
6. Contact Info

1. Revision History
	- v1.0 (20 October 2009)
		- Initial release.

2. Introduction
Ted is a simple GUI-based text dumper utility I originally wrote for Terra Incognita, a 1999 Net Yaroze game. At first
I'd planned on writing a full-blown text editor, but after a couple of attempts I decided it was too much work,
especially since I discovered Kruptar which did almost everything I wanted. Almost, because with Kruptar when you load
text blocks into it, it doesn't ignore empty spaces, meaning nearly every string had one to four nulls in front of it.
Hours of painfully going through and manually adding each pointer in made me realise that doing it by hand just takes
too long, so I started coding a pointer-list exporter that fetched starting addresses for each line of text in Terra.
When it was almost done, I realised "Hey, maybe I can get it to dump text as well!" so I added that feature. Then I
realised "Hey, maybe I can get it to do this for any game with string terminators!" And so Ted was born.

3. Installation
Assuming that you got this program in a ZIP archive (or some kind of archive), you'll obviously need to extract
"Ted.exe" to somewhere (it doesn't matter where, but preferably somewhere you can get to easily). In order to run Ted,
you'll need the .NET Framework 3.5 or later installed on your computer. If you're running Windows XP SP3 or any newer
version of Windows, chances are you already have it as it's installed by default. If you don't have it, you can
download the latest version free of charge from Microsoft's website. If you aren't running Windows at all, you can try
downloading and installing Mono from http://www.mono-project.com/. Let me know if it works - I haven't tested it with
Mono. ;)

4. Usage
Ted is pretty simple to use. When you start the program, you'll need to set some options for loading text blocks in.
These are:
	- Source: The path of the ROM you're reading from.
	- Start Address: The starting position to read from. Note that the first line of text always begins here.
	- End Address: The cutoff address for file reading. This should be the last character in the text block.
	- Encoding: The encoding of the text block. Ted supports every encoding that .NET does, which is basically every
				encoding in existence, but not table files (yes it's stupid, but this will be fixed).
	- End Byte/s: The bytes which specify the end of a line of text. This must be a decimal or hexadecimal value.
Once you've set all of these options, click "Load Text". Each line of text will be loaded into the program. Once this
is done, you can preview each line of text by selecting it in the list box. You can now export a Kruptar-format list
of pointers by selecting File -> Export -> Kruptar Pointer List..., and dump the script itself by selecting
File -> Export -> Raw Script Dump...

5. FAQs
Actually since this is the first release, there's no need for an FAQ section. For now this is just a placeholder. :)

6. Contact Info
If you have any questions about Ted, would like to suggest a new feature, or found a bug in the program, feel free to
drop me a private message at http://www.romhacking.net/forum. It's not that I don't have an email; I just don't want
it filled with spam and whatnot, and in any case I don't get enough PMs from people.